home *** CD-ROM | disk | FTP | other *** search
/ Aminet 45 / Aminet 45 (2001)(GTI - Schatztruhe)[!][Oct 2001].iso / Aminet / game / role / ldmud-3.2-bin.lha / mud / doc / efun / functionlist < prev    next >
Text File  |  2001-03-19  |  2KB  |  50 lines
  1. NAME
  2.         #include <sys/functionlist.h>
  3.         #include <sys/lpctypes.h>
  4.  
  5.         mixed *functionlist (object ob, int flags = RETURN_FUNCTION_NAME)
  6.  
  7. SYNOPSIS
  8.         Return an array with information about <ob>s lfunctions. For every
  9.         function, 1 to 4 values (depending on <flags>) are stored in
  10.         the result array conveying in this order:
  11.           - the name of the function
  12.           - the function flags (see below)
  13.           - the return type (listed in mudlib/sys/lpctypes.h)
  14.           - the number of accepted argumens
  15.        
  16.         <ob> may be given as true object or as a filename. In the latter
  17.         case, the efun does not try to load the object before proceeding.
  18.        
  19.         <flags> determines both which information is returned for every
  20.         function, and which functions should be considered at all.
  21.         Its value is created by bin-or'ing together following flags from
  22.         mudlib/sys/functionlist.h:
  23.        
  24.           Control of returned information:
  25.             RETURN_FUNCTION_NAME    include the function name
  26.             RETURN_FUNCTION_FLAGS   include the function flags
  27.             RETURN_FUNCTION_TYPE    include the return type
  28.             RETURN_FUNCTION_NUMARG  include the number of arguments.
  29.        
  30.             The name RETURN_FUNCTION_ARGTYPE is defined but not implemented.
  31.        
  32.           Control of listed functions:
  33.             NAME_INHERITED      don't list if defined by inheritance
  34.             TYPE_MOD_STATIC     don't list if static function
  35.             TYPE_MOD_PRIVATE    don't list if private
  36.             TYPE_MOD_PROTECTED  don't list if protected
  37.             NAME_HIDDEN         don't list if not visible through inheritance
  38.        
  39.         The 'flags' information consists of the bin-or of the list control
  40.         flags given above, plus the following:
  41.        
  42.             TYPE_MOD_VARARGS    function takes varargs
  43.             NAME_UNDEFINED      function not defined yet, but referenced.
  44.             NAME_CROSS_DEFINED  function is defined to be in a different program
  45.             TYPE_MOD_NO_MASK    function is nomask
  46.             TYPE_MOD_PUBLIC     function is public
  47.  
  48. SEE ALSO
  49.         inherit_list(E), function_exists(E), call_resolved(E)
  50.